feat(api): refactor Query.target + expose via public API (#6656)

Author: n1ru4l

integration-tests/testkit/collections.ts

@@ -2,7 +2,7 @@ import { graphql } from './gql';
 
 export const FindCollectionQuery = graphql(`
   query Collection($selector: TargetSelectorInput!, $id: ID!) {
-    target(selector: $selector) {
+    target(reference: { bySelector: $selector }) {
       id
       documentCollection(id: $id) {
         id

integration-tests/testkit/flow.ts

@@ -631,7 +631,7 @@ export function readTargetInfo(
   return execute({
     document: graphql(`
       query readTargetInfo($selector: TargetSelectorInput!) {
-        target(selector: $selector) {
+        target(reference: { bySelector: $selector }) {
           id
           slug
         }
@@ -1085,7 +1085,7 @@ export function readOperationBody(
   return execute({
     document: graphql(`
       query readOperationBody($selector: TargetSelectorInput!, $hash: String!) {
-        target(selector: $selector) {
+        target(reference: { bySelector: $selector }) {
           id
           operation(hash: $hash) {
             body
@@ -1195,7 +1195,7 @@ export function fetchVersions(selector: TargetSelectorInput, first: number, toke
   return execute({
     document: graphql(`
       query schemaVersions($first: Int!, $selector: TargetSelectorInput!) {
-        target(selector: $selector) {
+        target(reference: { bySelector: $selector }) {
           schemaVersions(first: $first) {
             edges {
               node {
@@ -1261,10 +1261,12 @@ export function compareToPreviousVersion(
         $version: ID!
       ) {
         target(
-          selector: {
-            organizationSlug: $organizationSlug
-            projectSlug: $projectSlug
-            targetSlug: $targetSlug
+          reference: {
+            bySelector: {
+              organizationSlug: $organizationSlug
+              projectSlug: $projectSlug
+              targetSlug: $targetSlug
+            }
           }
         ) {
           id

integration-tests/tests/api/app-deployments.spec.ts

@@ -35,7 +35,7 @@ const GetAppDeployment = graphql(`
     $appDeploymentName: String!
     $appDeploymentVersion: String!
   ) {
-    target(selector: $targetSelector) {
+    target(reference: { bySelector: $targetSelector }) {
       appDeployment(appName: $appDeploymentName, appVersion: $appDeploymentVersion) {
         id
         lastUsed
@@ -112,7 +112,7 @@ const GetPaginatedPersistedDocuments = graphql(`
     $first: Int
     $cursor: String
   ) {
-    target(selector: $targetSelector) {
+    target(reference: { bySelector: $targetSelector }) {
       appDeployment(appName: $appDeploymentName, appVersion: $appDeploymentVersion) {
         id
         documents(first: $first, after: $cursor) {

integration-tests/tests/api/artifacts-cdn.spec.ts

@@ -433,7 +433,7 @@ runArtifactsCDNTests('API Mirror', { service: 'server', port: 8082, path: '/arti
 describe('CDN token', () => {
   const TargetCDNAccessTokensQuery = graphql(`
     query TargetCDNAccessTokens($selector: TargetSelectorInput!, $after: String, $first: Int = 2) {
-      target(selector: $selector) {
+      target(reference: { bySelector: $selector }) {
         cdnAccessTokens(first: $first, after: $after) {
           pageInfo {
             hasNextPage

integration-tests/tests/api/schema/check.spec.ts

@@ -120,7 +120,7 @@ test.concurrent('should match indentation of previous description', async ({ exp
 
 const SchemaCheckQuery = graphql(/* GraphQL */ `
   query SchemaCheckOnTargetQuery($selector: TargetSelectorInput!, $id: ID!) {
-    target(selector: $selector) {
+    target(reference: { bySelector: $selector }) {
       schemaCheck(id: $id) {
         __typename
         id

integration-tests/tests/api/schema/contracts-check.spec.ts

@@ -300,7 +300,7 @@ const ApproveFailedSchemaCheckMutation = graphql(/* GraphQL */ `
 
 const SchemaCheckQuery = graphql(/* GraphQL */ `
   query SchemaCheckContractsQuery($selector: TargetSelectorInput!, $id: ID!) {
-    target(selector: $selector) {
+    target(reference: { bySelector: $selector }) {
       schemaCheck(id: $id) {
         __typename
         id

integration-tests/tests/api/schema/publish.spec.ts

@@ -2588,10 +2588,12 @@ const SchemaCompareToPreviousVersionQuery = graphql(`
     $version: ID!
   ) {
     target(
-      selector: {
-        organizationSlug: $organizationSlug
-        projectSlug: $projectSlug
-        targetSlug: $targetSlug
+      reference: {
+        bySelector: {
+          organizationSlug: $organizationSlug
+          projectSlug: $projectSlug
+          targetSlug: $targetSlug
+        }
       }
     ) {
       id

integration-tests/tests/api/target/usage.spec.ts

@@ -2095,7 +2095,7 @@ test.concurrent(
 
 const SubscriptionSchemaCheckQuery = graphql(/* GraphQL */ `
   query SubscriptionSchemaCheck($selector: TargetSelectorInput!, $id: ID!) {
-    target(selector: $selector) {
+    target(reference: { bySelector: $selector }) {
       schemaCheck(id: $id) {
         __typename
         id

packages/services/api/src/modules/shared/providers/id-translator.ts

@@ -107,7 +107,7 @@ export class IdTranslator {
       targetId: string;
     };
 
-    if (args.reference?.bySelector) {
+    if (args.reference?.bySelector != null) {
       try {
         const [organizationId, projectId, targetId] = await Promise.all([
           this.translateOrganizationId(args.reference.bySelector),
@@ -131,7 +131,7 @@ export class IdTranslator {
         this.logger.debug('Failed to resolve input slug to ids (slug=%o)', args.reference);
         return null;
       }
-    } else if (args.reference?.byId) {
+    } else if (args.reference?.byId != null) {
       if (!isUUID(args.reference.byId)) {
         this.logger.debug('Invalid uuid provided. (targetId=%s)', args.reference.byId);
         return null;

packages/services/api/src/modules/target/module.graphql.ts

@@ -2,7 +2,7 @@ import { gql } from 'graphql-modules';
 
 export default gql`
   extend type Query {
-    target(selector: TargetSelectorInput!): Target
+    target(reference: TargetReferenceInput! @tag(name: "public")): Target @tag(name: "public")
     targets(selector: ProjectSelectorInput!): TargetConnection!
   }
 
@@ -120,9 +120,9 @@ export default gql`
   }
 
   input TargetSelectorInput {
-    organizationSlug: String!
-    projectSlug: String!
-    targetSlug: String!
+    organizationSlug: String! @tag(name: "public")
+    projectSlug: String! @tag(name: "public")
+    targetSlug: String! @tag(name: "public")
   }
 
   """
@@ -132,11 +132,11 @@ export default gql`
     """
     Reference to a target using it's ID (see "Target.id" field).
     """
-    byId: ID
+    byId: ID @tag(name: "public")
     """
     Reference to a target using it's slug parts (see "Organization.slug", "Project.slug", "Target.slug").
     """
-    bySelector: TargetSelectorInput
+    bySelector: TargetSelectorInput @tag(name: "public")
   }
 
   input UpdateTargetValidationSettingsInput {
@@ -195,8 +195,8 @@ export default gql`
   }
 
   type Target {
-    id: ID!
-    slug: String!
+    id: ID! @tag(name: "public")
+    slug: String! @tag(name: "public")
     cleanId: ID! @deprecated(reason: "Use the 'slug' field instead.")
     name: String! @deprecated(reason: "Use the 'slug' field instead.")
     project: Project!

packages/services/api/src/modules/target/providers/target-manager.ts

@@ -1,4 +1,5 @@
 import { Injectable, Scope } from 'graphql-modules';
+import { TargetReferenceInput } from 'packages/libraries/core/src/client/__generated__/types';
 import * as zod from 'zod';
 import type { Project, Target, TargetSettings } from '../../../shared/entities';
 import { share } from '../../../shared/helpers';
@@ -166,6 +167,15 @@ export class TargetManager {
     return this.storage.getTarget(selector);
   }
 
+  async getTargetByReferenceInput(reference: TargetReferenceInput) {
+    const selector = await this.idTranslator.resolveTargetReference({ reference });
+
+    if (!selector) {
+      this.session.raise('project:describe');
+    }
+    return this.getTarget(selector);
+  }
+
   async getTargetBySlugForProject(project: Project, targetSlug: string) {
     return await this.storage.getTargetBySlug({
       slug: targetSlug,

packages/services/api/src/modules/target/resolvers/Query/target.ts

@@ -1,22 +1,10 @@
-import { IdTranslator } from '../../../shared/providers/id-translator';
 import { TargetManager } from '../../providers/target-manager';
 import type { QueryResolvers } from './../../../../__generated__/types';
 
 export const target: NonNullable<QueryResolvers['target']> = async (
   _,
-  { selector },
+  { reference },
   { injector },
 ) => {
-  const translator = injector.get(IdTranslator);
-  const [organization, project, target] = await Promise.all([
-    translator.translateOrganizationId(selector),
-    translator.translateProjectId(selector),
-    translator.translateTargetId(selector),
-  ]);
-
-  return injector.get(TargetManager).getTarget({
-    organizationId: organization,
-    targetId: target,
-    projectId: project,
-  });
+  return injector.get(TargetManager).getTargetByReferenceInput(reference);
 };

packages/web/app/src/components/layouts/target.tsx

@@ -285,7 +285,7 @@ export const TargetLayout = ({
 
 const ConnectSchemaModalQuery = graphql(`
   query ConnectSchemaModal($targetSelector: TargetSelectorInput!) {
-    target(selector: $targetSelector) {
+    target(reference: { bySelector: $targetSelector }) {
       id
       project {
         id

packages/web/app/src/components/target/explorer/filter.tsx

@@ -37,10 +37,12 @@ const TypeFilter_AllTypes = graphql(`
     $period: DateRangeInput!
   ) {
     target(
-      selector: {
-        organizationSlug: $organizationSlug
-        projectSlug: $projectSlug
-        targetSlug: $targetSlug
+      reference: {
+        bySelector: {
+          organizationSlug: $organizationSlug
+          projectSlug: $projectSlug
+          targetSlug: $targetSlug
+        }
       }
     ) {
       __typename

packages/web/app/src/components/target/laboratory/create-collection-modal.tsx

@@ -26,7 +26,7 @@ import { zodResolver } from '@hookform/resolvers/zod';
 
 const CollectionQuery = graphql(`
   query Collection($selector: TargetSelectorInput!, $id: ID!) {
-    target(selector: $selector) {
+    target(reference: { bySelector: $selector }) {
       id
       documentCollection(id: $id) {
         id

packages/web/app/src/components/target/settings/cdn-access-tokens.tsx

@@ -296,7 +296,7 @@ function DeleteCDNAccessTokenModal(props: {
 
 const CDNAccessTokensQuery = graphql(`
   query CDNAccessTokensQuery($selector: TargetSelectorInput!, $first: Int!, $after: String) {
-    target(selector: $selector) {
+    target(reference: { bySelector: $selector }) {
       id
       cdnAccessTokens(first: $first, after: $after) {
         edges {

packages/web/app/src/components/target/settings/schema-contracts.tsx

@@ -46,7 +46,7 @@ import { InfoCircledIcon } from '@radix-ui/react-icons';
 
 const SchemaContractsQuery = graphql(`
   query SchemaContractsQuery($selector: TargetSelectorInput!, $after: String) {
-    target(selector: $selector) {
+    target(reference: { bySelector: $selector }) {
       id
       ...CreateContractDialogContentTargetFragment
       contracts(after: $after) {

packages/web/app/src/lib/hooks/laboratory/use-collections.ts

@@ -6,7 +6,7 @@ import { useNotifications } from '@/lib/hooks';
 
 export const CollectionsQuery = graphql(`
   query Collections($selector: TargetSelectorInput!) {
-    target(selector: $selector) {
+    target(reference: { bySelector: $selector }) {
       id
       documentCollections {
         edges {

packages/web/app/src/lib/hooks/laboratory/use-current-operation.ts

@@ -4,7 +4,7 @@ import { useOperationFromQueryString } from './useOperationFromQueryString';
 
 const OperationQuery = graphql(`
   query Operation($selector: TargetSelectorInput!, $id: ID!) {
-    target(selector: $selector) {
+    target(reference: { bySelector: $selector }) {
       id
       documentCollectionOperation(id: $id) {
         id

packages/web/app/src/lib/hooks/laboratory/use-operation-collections-plugin.tsx

@@ -81,10 +81,12 @@ export const TargetLaboratoryPageQuery = graphql(`
     $targetSlug: String!
   ) {
     target(
-      selector: {
-        organizationSlug: $organizationSlug
-        projectSlug: $projectSlug
-        targetSlug: $targetSlug
+      reference: {
+        bySelector: {
+          organizationSlug: $organizationSlug
+          projectSlug: $projectSlug
+          targetSlug: $targetSlug
+        }
       }
     ) {
       id

packages/web/app/src/pages/target-app-version.tsx

@@ -42,10 +42,12 @@ const TargetAppsVersionQuery = graphql(`
     $after: String
   ) {
     target(
-      selector: {
-        organizationSlug: $organizationSlug
-        projectSlug: $projectSlug
-        targetSlug: $targetSlug
+      reference: {
+        bySelector: {
+          organizationSlug: $organizationSlug
+          projectSlug: $projectSlug
+          targetSlug: $targetSlug
+        }
       }
     ) {
       id

packages/web/app/src/pages/target-apps.tsx

@@ -48,10 +48,12 @@ const TargetAppsViewQuery = graphql(`
       id
     }
     target(
-      selector: {
-        organizationSlug: $organizationSlug
-        projectSlug: $projectSlug
-        targetSlug: $targetSlug
+      reference: {
+        bySelector: {
+          organizationSlug: $organizationSlug
+          projectSlug: $projectSlug
+          targetSlug: $targetSlug
+        }
       }
     ) {
       id
@@ -88,10 +90,12 @@ const TargetAppsViewFetchMoreQuery = graphql(`
     $after: String!
   ) {
     target(
-      selector: {
-        organizationSlug: $organizationSlug
-        projectSlug: $projectSlug
-        targetSlug: $targetSlug
+      reference: {
+        bySelector: {
+          organizationSlug: $organizationSlug
+          projectSlug: $projectSlug
+          targetSlug: $targetSlug
+        }
       }
     ) {
       id