add $args for file upload to access additional arguments

Author: icebob

CHANGELOG.md

@@ -1,3 +1,10 @@
+--------------------------------------------------
+<a name="0.3.3"></a>
+# 0.3.3 (2020-09-08)
+
+## Changes
+- add `ctx.meta.$args` to store additional arguments in case of file uploading.
+
 --------------------------------------------------
 <a name="0.3.2"></a>
 # 0.3.2 (2020-08-30)

examples/upload/index.js

@@ -66,7 +66,7 @@ broker.createService({
 		},
 		singleUpload: {
 			graphql: {
-				mutation: "singleUpload(file: Upload!): File!",
+				mutation: "singleUpload(file: Upload!, other: String): File!",
 				fileUploadArg: "file",
 			},
 			async handler(ctx) {
@@ -75,8 +75,8 @@ broker.createService({
 					fileChunks.push(chunk);
 				}
 				const fileContents = Buffer.concat(fileChunks);
-				ctx.broker.logger.info("Uploaded File Contents:");
-				ctx.broker.logger.info(fileContents.toString());
+				ctx.broker.logger.info("Uploaded File Contents:", fileContents.toString());
+				ctx.broker.logger.info("Additional arguments:", ctx.meta.$args);
 				return ctx.meta.$fileInfo;
 			},
 		},

src/service.js

@@ -15,7 +15,7 @@ const GraphQL = require("graphql");
 const { PubSub, withFilter } = require("graphql-subscriptions");
 const hash = require("object-hash");
 
-module.exports = function(mixinOptions) {
+module.exports = function (mixinOptions) {
 	mixinOptions = _.defaultsDeep(mixinOptions, {
 		routeOptions: {
 			path: "/graphql",
@@ -212,6 +212,8 @@ module.exports = function(mixinOptions) {
 								? await dataLoader.loadMany(dataLoaderKey)
 								: await dataLoader.load(dataLoaderKey);
 						} else if (fileUploadArg != null && args[fileUploadArg] != null) {
+							const additionalArgs = _.omit(args, [fileUploadArg]);
+
 							if (Array.isArray(args[fileUploadArg])) {
 								return await Promise.all(
 									args[fileUploadArg].map(async uploadPromise => {
@@ -221,7 +223,7 @@ module.exports = function(mixinOptions) {
 										} = await uploadPromise;
 										const stream = createReadStream();
 										return context.ctx.call(actionName, stream, {
-											meta: { $fileInfo },
+											meta: { $fileInfo, $args: additionalArgs },
 										});
 									})
 								);
@@ -230,7 +232,7 @@ module.exports = function(mixinOptions) {
 							const { createReadStream, ...$fileInfo } = await args[fileUploadArg];
 							const stream = createReadStream();
 							return await context.ctx.call(actionName, stream, {
-								meta: { $fileInfo },
+								meta: { $fileInfo, $args: additionalArgs },
 							});
 						} else {
 							const params = {};

test/unit/service.spec.js

@@ -563,7 +563,7 @@ describe("Test Service", () => {
 				createReadStream: () => "fake read stream",
 			};
 
-			const res = await resolver(fakeRoot, { file }, { ctx });
+			const res = await resolver(fakeRoot, { file, other: "something" }, { ctx });
 
 			expect(res).toBe("response from action");
 
@@ -575,6 +575,7 @@ describe("Test Service", () => {
 						encoding: "7bit",
 						mimetype: "text/plain",
 					},
+					$args: { other: "something" },
 				},
 			});
 		});
@@ -604,7 +605,7 @@ describe("Test Service", () => {
 				},
 			];
 
-			const res = await resolver(fakeRoot, { files }, { ctx });
+			const res = await resolver(fakeRoot, { files, other: "something" }, { ctx });
 
 			expect(res).toEqual([
 				"response for fake read stream 1",
@@ -619,6 +620,7 @@ describe("Test Service", () => {
 						encoding: "7bit",
 						mimetype: "text/plain",
 					},
+					$args: { other: "something" },
 				},
 			});
 			expect(ctx.call).toBeCalledWith("posts.uploadMulti", "fake read stream 2", {
@@ -628,6 +630,7 @@ describe("Test Service", () => {
 						encoding: "7bit",
 						mimetype: "text/plain",
 					},
+					$args: { other: "something" },
 				},
 			});
 		});