Skip to content

fix(deprecation): add clientStubFromCloudEndpoint method #138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 19, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,14 +128,14 @@ If you want to connect to Dgraph running on your [Dgraph Cloud](https://cloud.dg
```js
const dgraph = require("dgraph-js");

const clientStub = dgraph.clientStubFromSlashGraphQLEndpoint(
const clientStub = dgraph.clientStubFromCloudEndpoint(
"https://frozen-mango.eu-central-1.aws.cloud.dgraph.io/graphql",
"<api-key>"
);
const dgraphClient = new dgraph.DgraphClient(clientStub);
```

**Note:** the `clientStubFromSlashGraphQLEndpoint` method is deprecated and will be removed in the next release.
**Note:** the `clientStubFromSlashGraphQLEndpoint` method is deprecated and will be removed in the next release. Instead use `clientStubFromCloudEndpoint` method.

### Altering the Database

Expand Down Expand Up @@ -499,4 +499,3 @@ Make sure you have a Dgraph server running on localhost before you run this task
```sh
npm test
```

1 change: 0 additions & 1 deletion lib/client.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
}
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.deleteEdges = exports.isJwtExpired = exports.DgraphClient = void 0;
var messages = require("../generated/api_pb");
var errors_1 = require("./errors");
var txn_1 = require("./txn");
Expand Down
1 change: 0 additions & 1 deletion lib/clientStub.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
}
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.DgraphClientStub = void 0;
var grpc = require("@grpc/grpc-js");
var services = require("../generated/api_grpc_pb");
var messages = require("../generated/api_pb");
Expand Down
1 change: 1 addition & 0 deletions lib/clientStubFromSlash.d.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
import { DgraphClientStub } from "./clientStub";
export declare function clientStubFromSlashGraphQLEndpoint(graphqlEndpoint: string, apiKey: string): DgraphClientStub;
export declare function clientStubFromCloudEndpoint(graphqlEndpoint: string, apiKey: string): DgraphClientStub;
7 changes: 5 additions & 2 deletions lib/clientStubFromSlash.js
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.clientStubFromSlashGraphQLEndpoint = void 0;
var grpc = require("@grpc/grpc-js");
var Url = require("url-parse");
var clientStub_1 = require("./clientStub");
var PORT = "443";
function clientStubFromSlashGraphQLEndpoint(graphqlEndpoint, apiKey) {
return clientStubFromCloudEndpoint(graphqlEndpoint, apiKey);
}
exports.clientStubFromSlashGraphQLEndpoint = clientStubFromSlashGraphQLEndpoint;
function clientStubFromCloudEndpoint(graphqlEndpoint, apiKey) {
var url = new Url(graphqlEndpoint);
var urlParts = url.host.split(".");
var firstHalf = urlParts[0];
Expand All @@ -19,4 +22,4 @@ function clientStubFromSlashGraphQLEndpoint(graphqlEndpoint, apiKey) {
var credentials = grpc.credentials.combineChannelCredentials(grpc.credentials.createSsl(), metaCreds);
return new clientStub_1.DgraphClientStub(backenedURL, credentials);
}
exports.clientStubFromSlashGraphQLEndpoint = clientStubFromSlashGraphQLEndpoint;
exports.clientStubFromCloudEndpoint = clientStubFromCloudEndpoint;
43 changes: 18 additions & 25 deletions lib/dgraph.js
Original file line number Diff line number Diff line change
@@ -1,29 +1,22 @@
"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __exportStar = (this && this.__exportStar) || function(m, exports) {
for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
};
function __export(m) {
for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
}
Object.defineProperty(exports, "__esModule", { value: true });
__exportStar(require("./types"), exports);
__export(require("./types"));
var api_pb_1 = require("../generated/api_pb");
Object.defineProperty(exports, "Operation", { enumerable: true, get: function () { return api_pb_1.Operation; } });
Object.defineProperty(exports, "Request", { enumerable: true, get: function () { return api_pb_1.Request; } });
Object.defineProperty(exports, "TxnContext", { enumerable: true, get: function () { return api_pb_1.TxnContext; } });
Object.defineProperty(exports, "Check", { enumerable: true, get: function () { return api_pb_1.Check; } });
Object.defineProperty(exports, "Version", { enumerable: true, get: function () { return api_pb_1.Version; } });
Object.defineProperty(exports, "NQuad", { enumerable: true, get: function () { return api_pb_1.NQuad; } });
Object.defineProperty(exports, "Value", { enumerable: true, get: function () { return api_pb_1.Value; } });
Object.defineProperty(exports, "Facet", { enumerable: true, get: function () { return api_pb_1.Facet; } });
Object.defineProperty(exports, "Latency", { enumerable: true, get: function () { return api_pb_1.Latency; } });
__exportStar(require("./clientStub"), exports);
__exportStar(require("./client"), exports);
__exportStar(require("./clientStubFromSlash"), exports);
__exportStar(require("./txn"), exports);
__exportStar(require("./errors"), exports);
exports.Operation = api_pb_1.Operation;
exports.Request = api_pb_1.Request;
exports.TxnContext = api_pb_1.TxnContext;
exports.Check = api_pb_1.Check;
exports.Version = api_pb_1.Version;
exports.NQuad = api_pb_1.NQuad;
exports.Value = api_pb_1.Value;
exports.Facet = api_pb_1.Facet;
exports.Latency = api_pb_1.Latency;
__export(require("./clientStub"));
__export(require("./client"));
__export(require("./clientStubFromSlash"));
__export(require("./txn"));
__export(require("./errors"));
exports.grpc = require("@grpc/grpc-js");
1 change: 0 additions & 1 deletion lib/errors.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.ERR_REFRESH_JWT_EMPTY = exports.ERR_READ_ONLY = exports.ERR_BEST_EFFORT_REQUIRED_READ_ONLY = exports.ERR_ABORTED = exports.ERR_FINISHED = exports.ERR_NO_CLIENTS = void 0;
exports.ERR_NO_CLIENTS = new Error("No clients provided in DgraphClient constructor");
exports.ERR_FINISHED = new Error("Transaction has already been committed or discarded");
exports.ERR_ABORTED = new Error("Transaction has been aborted. Please retry");
Expand Down
15 changes: 4 additions & 11 deletions lib/index.js
Original file line number Diff line number Diff line change
@@ -1,15 +1,8 @@
"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __exportStar = (this && this.__exportStar) || function(m, exports) {
for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
};
function __export(m) {
for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
}
Object.defineProperty(exports, "__esModule", { value: true });
var dgraph = require("./dgraph");
__exportStar(require("./dgraph"), exports);
__export(require("./dgraph"));
exports.default = dgraph;
1 change: 0 additions & 1 deletion lib/txn.js
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
}
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.Txn = void 0;
var messages = require("../generated/api_pb");
var client_1 = require("./client");
var errors_1 = require("./errors");
Expand Down
1 change: 0 additions & 1 deletion lib/types.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ var __extends = (this && this.__extends) || (function () {
};
})();
Object.defineProperty(exports, "__esModule", { value: true });
exports.Mutation = exports.createResponse = exports.Response = exports.createPayload = exports.Payload = void 0;
var jspb = require("google-protobuf");
var messages = require("../generated/api_pb");
var util_1 = require("./util");
Expand Down
3 changes: 1 addition & 2 deletions lib/util.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.strToJson = exports.u8ToStr = exports.b64ToStr = exports.strToU8 = exports.strToB64 = exports.stringifyMessage = exports.promisify3 = exports.promisify1 = exports.isUnauthenticatedError = exports.isConflictError = exports.isAbortedError = exports.errorCode = void 0;
var grpc = require("@grpc/grpc-js");
function errorCode(err) {
if (err === undefined ||
Expand Down Expand Up @@ -64,7 +63,7 @@ function stringifyMessage(msg) {
}
exports.stringifyMessage = stringifyMessage;
var is_base64_1 = require("is-base64");
Object.defineProperty(exports, "isBase64", { enumerable: true, get: function () { return is_base64_1.isBase64; } });
exports.isBase64 = is_base64_1.isBase64;
function strToB64(str) {
return Buffer.from(str, "utf8").toString("base64");
}
Expand Down
11 changes: 9 additions & 2 deletions src/clientStubFromSlash.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,20 @@ import { DgraphClientStub } from "./clientStub";

const PORT = "443";
/**
* @deprecated since v21.3 and will be removed in v21.07 release. For more details, see:
* https://discuss.dgraph.io/t/regarding-slash-cloud-dgraph-endpoints-in-the-clients/13492
* @deprecated since v21.3 and will be removed in v21.07 release.
* Please use {@link clientStubFromCloudEndpoint} instead.
*/

export function clientStubFromSlashGraphQLEndpoint(
graphqlEndpoint: string,
apiKey: string,
) {
return clientStubFromCloudEndpoint(graphqlEndpoint, apiKey);
}

export function clientStubFromCloudEndpoint(
graphqlEndpoint: string,
apiKey: string,
) {
const url = new Url(graphqlEndpoint);
const urlParts = url.host.split(".");
Expand Down