Skip to content
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

fix: improve proto checking for hgetall [skip ci] #1418

Merged
merged 2 commits into from
Aug 18, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/command.ts
Original file line number Diff line number Diff line change
Expand Up @@ -429,7 +429,7 @@ Command.setReplyTransformer("hgetall", function (result) {
for (let i = 0; i < result.length; i += 2) {
const key = result[i];
const value = result[i + 1];
if (obj[key]) {
if (key in obj) {
// can only be truthy if the property is special somehow, like '__proto__' or 'constructor'
// https://github.com/luin/ioredis/issues/1267
Object.defineProperty(obj, key, {
Expand Down
30 changes: 27 additions & 3 deletions test/functional/hgetall.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,36 @@
import Redis from "../../lib/redis";
import { expect } from "chai";

const CUSTOM_PROPERTY = "_myCustomProperty";

describe("hgetall", function () {
it("should handle __proto__", async function () {
beforeEach(function () {
Object.defineProperty(Object.prototype, CUSTOM_PROPERTY, {
value: false,
configurable: true,
enumerable: false,
writable: false,
});
});

afterEach(function () {
delete (Object.prototype as any)[CUSTOM_PROPERTY];
});

it("should handle special field names", async function () {
const redis = new Redis();
await redis.hset("test_key", "__proto__", "hello");
await redis.hmset(
"test_key",
"__proto__",
"hello",
CUSTOM_PROPERTY,
"world"
);
const ret = await redis.hgetall("test_key");
expect(ret.__proto__).to.eql("hello");
expect(Object.keys(ret)).to.eql(["__proto__"]);
expect(ret[CUSTOM_PROPERTY]).to.eql("world");
expect(Object.keys(ret).sort()).to.eql(
["__proto__", CUSTOM_PROPERTY].sort()
);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unrelated to this change: Could also check that expect(Object.getPrototypeOf(ret)).to.eql(Object.prototype); to confirm the original prototype isn't overridden, though the Object.keys() check pretty much implies that

});
});