WIP

Author: maneesht

e2e/data-connect/dataconnect-generated/js/default-connector/.guides/setup.md

@@ -0,0 +1,20 @@
+# Setup
+
+If the user hasn't already installed the SDK, always run the user's node package manager of choice, and install the package in the directory ../package.json.
+For more information on where the library is located, look at the connector.yaml file.
+
+```ts
+import { initializeApp } from 'firebase/app';
+
+initializeApp({
+  // fill in your project config here using the values from your Firebase project or from the `firebase_get_sdk_config` tool from the Firebase MCP server.
+});
+```
+
+Then, you can run the SDK as needed.
+```ts
+import { ... } from '@firebasegen/default-connector';
+```
+
+
+

e2e/data-connect/dataconnect-generated/js/default-connector/.guides/usage.md

@@ -0,0 +1,27 @@
+# Basic Usage
+
+Always prioritize using a supported framework over using the generated SDK
+directly. Supported frameworks simplify the developer experience and help ensure
+best practices are followed.
+
+
+
+
+
+## Advanced Usage
+If a user is not using a supported framework, they can use the generated SDK directly.
+
+Here's an example of how to use it with the first 5 operations:
+
+```js
+import { createMovie, listMovies } from '@firebasegen/default-connector';
+
+
+// Operation CreateMovie:  For variables, look at type CreateMovieVars in ../index.d.ts
+const { data } = await CreateMovie(dataConnect, createMovieVars);
+
+// Operation ListMovies: 
+const { data } = await ListMovies(dataConnect);
+
+
+```

e2e/data-connect/dataconnect-generated/js/default-connector/esm/index.esm.js

@@ -6,17 +6,6 @@ export const connectorConfig = {
   location: 'us-central1'
 };
 
-export const listMoviesRef = (dc) => {
-  const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined);
-  dcInstance._useGeneratedSdk();
-  return queryRef(dcInstance, 'ListMovies');
-}
-listMoviesRef.operationName = 'ListMovies';
-
-export function listMovies(dc) {
-  return executeQuery(listMoviesRef(dc));
-}
-
 export const createMovieRef = (dcOrVars, vars) => {
   const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true);
   dcInstance._useGeneratedSdk();
@@ -28,3 +17,14 @@ export function createMovie(dcOrVars, vars) {
   return executeMutation(createMovieRef(dcOrVars, vars));
 }
 
+export const listMoviesRef = (dc) => {
+  const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined);
+  dcInstance._useGeneratedSdk();
+  return queryRef(dcInstance, 'ListMovies');
+}
+listMoviesRef.operationName = 'ListMovies';
+
+export function listMovies(dc) {
+  return executeQuery(listMoviesRef(dc));
+}
+

e2e/data-connect/dataconnect-generated/js/default-connector/index.cjs.js

@@ -7,18 +7,6 @@ const connectorConfig = {
 };
 exports.connectorConfig = connectorConfig;
 
-const listMoviesRef = (dc) => {
-  const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined);
-  dcInstance._useGeneratedSdk();
-  return queryRef(dcInstance, 'ListMovies');
-}
-listMoviesRef.operationName = 'ListMovies';
-exports.listMoviesRef = listMoviesRef;
-
-exports.listMovies = function listMovies(dc) {
-  return executeQuery(listMoviesRef(dc));
-};
-
 const createMovieRef = (dcOrVars, vars) => {
   const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true);
   dcInstance._useGeneratedSdk();
@@ -30,3 +18,15 @@ exports.createMovieRef = createMovieRef;
 exports.createMovie = function createMovie(dcOrVars, vars) {
   return executeMutation(createMovieRef(dcOrVars, vars));
 };
+
+const listMoviesRef = (dc) => {
+  const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined);
+  dcInstance._useGeneratedSdk();
+  return queryRef(dcInstance, 'ListMovies');
+}
+listMoviesRef.operationName = 'ListMovies';
+exports.listMoviesRef = listMoviesRef;
+
+exports.listMovies = function listMovies(dc) {
+  return executeQuery(listMoviesRef(dc));
+};

e2e/data-connect/dataconnect-generated/js/default-connector/index.d.ts

@@ -34,18 +34,6 @@ export interface Movie_Key {
   __typename?: 'Movie_Key';
 }
 
-interface ListMoviesRef {
-  /* Allow users to create refs without passing in DataConnect */
-  (): QueryRef<ListMoviesData, undefined>;
-  /* Allow users to pass in custom DataConnect instances */
-  (dc: DataConnect): QueryRef<ListMoviesData, undefined>;
-  operationName: string;
-}
-export const listMoviesRef: ListMoviesRef;
-
-export function listMovies(): QueryPromise<ListMoviesData, undefined>;
-export function listMovies(dc: DataConnect): QueryPromise<ListMoviesData, undefined>;
-
 interface CreateMovieRef {
   /* Allow users to create refs without passing in DataConnect */
   (vars: CreateMovieVariables): MutationRef<CreateMovieData, CreateMovieVariables>;
@@ -58,3 +46,15 @@ export const createMovieRef: CreateMovieRef;
 export function createMovie(vars: CreateMovieVariables): MutationPromise<CreateMovieData, CreateMovieVariables>;
 export function createMovie(dc: DataConnect, vars: CreateMovieVariables): MutationPromise<CreateMovieData, CreateMovieVariables>;
 
+interface ListMoviesRef {
+  /* Allow users to create refs without passing in DataConnect */
+  (): QueryRef<ListMoviesData, undefined>;
+  /* Allow users to pass in custom DataConnect instances */
+  (dc: DataConnect): QueryRef<ListMoviesData, undefined>;
+  operationName: string;
+}
+export const listMoviesRef: ListMoviesRef;
+
+export function listMovies(): QueryPromise<ListMoviesData, undefined>;
+export function listMovies(dc: DataConnect): QueryPromise<ListMoviesData, undefined>;
+

e2e/data-connect/dataconnect/.dataconnect/schema/prelude.gql

@@ -205,6 +205,25 @@ input String_Filter {
   `LIKE '%value'`
   """
   endsWith: String
+  """
+  Match based on the provided pattern.
+  """
+  pattern: String_Pattern
+}
+
+input String_Pattern {
+  """
+  Match using LIKE semantics (https://www.postgresql.org/docs/current/functions-matching.html#FUNCTIONS-LIKE)
+  """
+  like: String @fdc_oneOf
+  """
+  Match against a POSIX regular expression.
+  """
+  regex: String @fdc_oneOf
+  """
+  If true, match patterns case-insensitively.
+  """
+  ignoreCase: Boolean
 }
 
 "Query filter criteris for `[String!]` scalar fields."
@@ -515,6 +534,50 @@ input Any_ListFilter {
   excludesAll: [Any!]
 }
 
+"""
+Mark a string field as searchable.
+When this directive is added, the field will be indexed for full-text search,
+and a <type>_search field will be generated at the query root.
+This directive accepts a `language` argument that defaults to `"english"` in
+case no value is specified.
+See:
+- go/fdc-full-text-search
+"""
+directive @searchable(
+  """
+   Language of the fields that you are searching over can be specified here
+   (e.g. "french", "spanish", etc.).
+   Defaults to "english" if not specified.
+  """
+  language: String = "english") on FIELD_DEFINITION
+
+extend type _Metadata {
+  # During full text search, the relevance of the query term to this row.
+  # In other cases, this field is not set.
+  relevance: Float
+}
+
+
+enum Search_QueryFormat @fdc_forbiddenAsFieldType {
+  """
+  Allows search engine style semantics (e.g. quoted strings, AND and OR).
+  """
+  QUERY,
+  """
+  Splits the query into words and does ANDs between them.
+  """
+  PLAIN,
+  """
+  Matches an exact phrase. Requires the words to be in the same order (i.e. "brown
+  dog" will not match "brown and red dog").
+  """
+  PHRASE,
+  """
+  Create complex queries using the full set of tsquery operators.
+  """
+  ADVANCED,
+}
+
 """
 (Internal) A string that uniquely identifies a type, field, and so on.
 
@@ -2129,69 +2192,3 @@ scalar Vector_Embed_Model
 
 # Intentionally left blank.
 
-"""
-Mark a string field as searchable.
-When this directive is added, the field will be indexed for full-text search,
-and a <type>_search field will be generated at the query root.
-This directive accepts a `language` argument that defaults to `"english"` in
-case no value is specified.
-See:
-- go/fdc-full-text-search
-"""
-directive @searchable(
-  """
-   Language of the fields that you are searching over can be specified here
-   (e.g. "french", "spanish", etc.).
-   Defaults to "english" if not specified.
-  """
-  language: String = "english") on FIELD_DEFINITION
-
-extend type _Metadata {
-  # During full text search, the relevance of the query term to this row.
-  # In other cases, this field is not set.
-  relevance: Float
-}
-
-
-enum Search_QueryFormat @fdc_forbiddenAsFieldType {
-  """
-  Allows search engine style semantics (e.g. quoted strings, AND and OR).
-  """
-  QUERY,
-  """
-  Splits the query into words and does ANDs between them.
-  """
-  PLAIN,
-  """
-  Matches an exact phrase. Requires the words to be in the same order (i.e. "brown
-  dog" will not match "brown and red dog").
-  """
-  PHRASE,
-  """
-  Create complex queries using the full set of tsquery operators.
-  """
-  ADVANCED,
-}
-
-input String_Pattern {
-  """
-  Match using LIKE semantics (https://www.postgresql.org/docs/current/functions-matching.html#FUNCTIONS-LIKE)
-  """
-  like: String @fdc_oneOf
-  """
-  Match against a POSIX regular expression.
-  """
-  regex: String @fdc_oneOf
-  """
-  If true, match patterns case-insensitively.
-  """
-  ignoreCase: Boolean
-}
-
-extend input String_Filter {
-  """
-  Match based on the provided pattern.
-  """
-  pattern: String_Pattern
-}
-

packages/data-connect/src/api/DataConnect.ts

@@ -194,7 +194,7 @@ export class DataConnect {
         this._transportOptions.sslEnabled
       );
     }
-    this._queryManager = new QueryManager(this._transport, this.cache);
+    this._queryManager = new QueryManager(this._transport, this.cache, this);
     this._mutationManager = new MutationManager(this._transport);
   }
 

packages/data-connect/src/api/query.ts

@@ -120,10 +120,10 @@ export function queryRef<Data, Variables>(
 ): QueryRef<Data, Variables> {
   dcInstance.setInitialized();
   if(initialCache !== undefined) {
-    console.log('updating cache!');
-    dcInstance._queryManager.updateCache(queryName, variables, initialCache);
+    // TODO: Check the TTL etc. to see if cache needs to be updated.
+    const changes = dcInstance._queryManager.updateCache(queryName, variables, initialCache);
+    dcInstance._queryManager.publishCacheResultsToSubscribers(changes);
   }
-  // dcInstance._queryManager.track(queryName, variables, initialCache);
   return {
     dataConnect: dcInstance,
     refType: QUERY_STR,

packages/data-connect/src/cache/BackingDataObject.ts

@@ -1,14 +1,34 @@
-// TODO: Consolidate Types
-type FDCScalarValue = string | number | boolean | undefined | null | object | FDCScalarValue[];
+export type FDCScalarValue = string | number | boolean | undefined | null | object | FDCScalarValue[];
 
 export class BackingDataObject {
-  private map = new Map<String, FDCScalarValue>();
-  constructor(public readonly globalID) {}
-  updateServerValue(key: string, value: FDCScalarValue) {
+  toStorableJson(): any {
+    // TODO: This might not be ok.
+    return this;
+  }
+  static fromStorableJson(json: any): BackingDataObject {
+    const bdo = new BackingDataObject(json.globalID);
+    // TODO: check whether the map can be stored in the database as-is
+    bdo.map = new Map<string, FDCScalarValue>(json.map);
+    // TODO: check whether the map can be stored in the database as-is
+    bdo.queriesReferenced = json.queriesReferenced;
+    return bdo;
+  }
+  private map = new Map<string, FDCScalarValue>();
+  private queriesReferenced = new Set<string>();
+  // private queryToFields = new Map<string, string[]>();
+  constructor(public readonly globalID: string) {}
+  updateServerValue(key: string, value: FDCScalarValue): string[] {
     this.map.set(key, value);
+    return Array.from(this.queriesReferenced);
+    // TODO: Collect queries that need to be updated.
   }
-  // TODO(mtewani): Track fields related to a query.
-  track(key: string, arg1: any) {
-    throw new Error('Method not implemented.');
+  track(queryId: string) {
+    this.queriesReferenced.add(queryId);
+    // if(!this.queryToFields.has(queryId)) {
+    //   this.queryToFields.set(queryId, []);
+    // }
+    // if(!this.queryToFields.get(queryId).includes(key)) {
+    //   this.queryToFields.get(queryId).push(key);
+    // }
   }
 }